dxp-ux

(0 reviews)

POST Create Payment (TMF-676)

CreatePayment

[POST]

This call is to create a payment using billingAccountNumber for a POSTPAID customer.

Request URL

https://[localhost]:[port]/dxp-ux/v1/{businessId}/payment

URL PARAMS

name	type	description	required
businessId	string	2 letter ISO 3166 country code (TT, BB, JM, PA, etc.) identifying the business unit.	Y

name	value	description	required
client_id	string	The client_id identifying the channel. Minimum characters: 5	Y
client_secret	string	Password associated with the client_id. Minimum characters: 5	Y
Correlation-ID	string	Identifier that correlates HTTP request between a client and server. Any identification model (UUDI, checksum, etc.) can be used, as long as it is a unique value to differentiate a transaction.	N
channelId	string	Channel to business: Allowed value: APP	Y
lob	string	The Line of Business Identifier Allowed value: POSTPAID	M
targetSystem	String	To identify the bss system Eg: aria	M

Request Body

{
    "account": {
        "id": "23541000-23542356",
        "@type": "CustomerAccountRef"
    },
    "amount": {
        "value": 11.6,
        "unit": "USD"
    },
    "paymentMethod": {
        "id": "PM-a6Idq00000005FpEAI",
        "@type": "PaymentMethodRef"
    },
    "@type": "Payment"
}

Request Data Model

This table include the field which are required to create payment in aria system.

name	type	description	required
account.id	string	Customer billing account id	Y
account.@type	string	Static text “CustomerAccountRef”	N
amount.value	Number	Payment Amount	N
amount.unit	string	“USD” , unit of amount	N
paymentmethod.id	string	Payment method Id	Y
paymentmethod.@type	string	“PaymentMethodRef” static text to refer the object	N
@type	string	“Payment” to refer the object	N

Response

In this section all the possible data structures received by the client at the moment of responding the method are defined.

Possible success response.

This section defines all the possible data structures received by the client and that must be considered satisfactory at the time of responding to the method.

{
    "id": "1642086856",
    "authorizationCode": "1642673206",
    "description": "476679901",
    "status": "done",
    "statusDate": "2022-01-20T13:00:00Z",
    "account": {
        "id": "23541000-23542356",
        "@type": "CustomerAccountRef"
    },
    "amount": {
        "value": 11.6,
        "unit": "USD"
    },
    "paymentMethod": {
        "id": "PM-a6Idq00000005FpEAI",
        "@type": "PaymentMethodRef"
    },
    "@type": "Payment"
}

Response Data Model

name	type	description	required
id	string	Processor Payment id	Y
status	string	value "done" if payment is succesful	Y
statusdate	datetime	Status date	N
authorizationcode	string	Authorization code provided by the issuing bank	Y
descrption	string	The unique identifier for a given transaction	Y
account.id	string	Customer billing account id	Y
account.@type	string	Static text “CustomerAccountRef”	N
amount.value	Number	Payment Amount	N
amount.unit	string	“USD” , unit of amount	N
paymentmethod.id	string	Payment method Id	Y
paymentmethod.@type	string	“PaymentMethodRef” static text to refer the object	N
@type	string	“Payment” to refer the object	N

Possible response error

In this section all the possible data structures received by the client are defined and that must be considered as unsatisfactory when responding to the method.

[ 400 ]

Bad Request - the request could not be understood by the server due to malformed syntax. The client SHOULD NOT repeat the request without modifications.

{
    "errors": [
        {
            "code": 400,
            "message": "VALIDATION:BLANK_STRING",
            "description": "Account Id is mandatory, cannot be blank"
        }
    ]
}
{
    "errors": [
        {
            "code": 400,
            "message": "ARIA:CREATEPAYMENT",
            "description": "4020 | Balance is less than zero"
        },
        {
            "code": 400,
            "message": "ARIA:BUSINESS_ERROR",
            "description": "4039 | Collection not attempted since a negative balance exists on the account"
        }
    ]
}

[ 405 ]

Method Not Allowed - HTTP method not allowed for this resource. The method specified in the Request-Line is not allowed for the resource identified by the Request-URI.

{
    "errors": [{
            "code": 405,
             "message": "APIKIT:METHOD_NOT_ALLOWED",
             "description": "HTTP Method get not allowed for : /{businessId}/payment"
        }]
}

[ 501 ]

Not implemented - indicates that the server does not support the functionality required to fulfill the request. This is the appropriate response when the server does not recognize the request method and is not capable of supporting it for any resource.

{
  "errors" : [{
      "code" : 501,
      "message" : "Not implemented",
      "description" : "Operation POST /payment for Business Id: xxxx not implemented"
    }]
  }